Air Velocity 2 Click Driver

API for configuring and manipulating Air Velocity 2 Click driver. More...

Topics
	Air Velocity 2 Settings
	Settings of Air Velocity 2 Click driver.
	Air Velocity 2 MikroBUS Map
	MikroBUS pin mapping of Air Velocity 2 Click driver.

Functions
void	airvelocity2_cfg_setup (airvelocity2_cfg_t *cfg)
	Air Velocity 2 configuration object setup function.
err_t	airvelocity2_init (airvelocity2_t *ctx, airvelocity2_cfg_t *cfg)
	Air Velocity 2 initialization function.
err_t	airvelocity2_read_output (airvelocity2_t *ctx, uint16_t *out_counts)
	Air Velocity 2 read output function.
float	airvelocity2_counts_to_mps (uint16_t out_counts)
	Air Velocity 2 counts to mps function.

Detailed Description

API for configuring and manipulating Air Velocity 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

airvelocity2_cfg_setup()

void airvelocity2_cfg_setup

(

airvelocity2_cfg_t *

cfg

)

Air Velocity 2 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See airvelocity2_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

airvelocity2_counts_to_mps()

float airvelocity2_counts_to_mps

(

uint16_t

out_counts

)

Air Velocity 2 counts to mps function.

This function converts raw output counts to velocity in m/sec (0-15).

Parameters

[in]

out_counts

: Output counts raw data.

Returns

Float value of velocity in m/sec (0-15).

Note

None.

airvelocity2_init()

err_t airvelocity2_init	(	airvelocity2_t *	ctx,
		airvelocity2_cfg_t *	cfg )

Air Velocity 2 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See airvelocity2_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See airvelocity2_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

airvelocity2_read_output()

err_t airvelocity2_read_output	(	airvelocity2_t *	ctx,
		uint16_t *	out_counts )

Air Velocity 2 read output function.

This function reads the raw output counts by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See airvelocity2_t object definition for detailed explanation.
[out]	out_counts	: Output counts raw data.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.